home *** CD-ROM | disk | FTP | other *** search
/ Popular Request / By Popular Request (Arsenal Computer)(SysOptics Distribution System).ISO / amiga1 / dlgtn121.lha / dlgul060.lha / DLGUpload060.doc < prev    next >
Text File  |  1991-12-08  |  10KB  |  245 lines
  1.    ****   **      ****  **  **        **                    **
  2.    ** **  **     **  ** **  **        **                    **
  3.    **  ** **     **     **  ** *****  **   ****   ****   *****
  4.    **  ** **     ** *** **  ** **  ** **  **  **     ** **  ** v0.60
  5.    **  ** **     **  ** **  ** **  ** **  **  **  ***** **  **
  6.    ** **  **     **  ** **  ** *****  **  **  ** **  ** **  ** by Michael
  7.    ****   ******  *****  ****  **      **  ****   *****  *****     Dreher
  8.                                **
  9.  
  10. First: jump to the end of this text and read the Disclaimer !!
  11. Secnd: jump back and start reading the instructions
  12. Third: enjoy using DLGUpload 0.60 !!
  13.  
  14.  
  15. What is it ??
  16. ~~~~~~~~~~~~~
  17. Just a simple proggie that enables you to Upload Files from a script
  18. or from the DOS-Shell to any File-Area or User's directory.
  19.  
  20.  
  21. Why DLGUpload ??
  22. ~~~~~~~~~~~~~~~~
  23. You know these problems ??:
  24.  
  25. - when online from remote, you get a message from a user who asks
  26.   for a special file which is not in the file-areas... You know that
  27.   it's on the system's harddisk, but it takes to much time to bring it
  28.   to that user's directory or a file-area. (there might be several
  29.   changes necessary between the DOS-Shell and FileMaint.. too much
  30.   work...)
  31. - you are at home and a user asks for a file or you have finished
  32.   the new KeyFile for XY, but you don't want to log in just for
  33.   uploading a file...
  34. - you have automated scripts which generate files to be uploaded to
  35.   several file-areas, but you have to upload them manually...
  36. - maybe you know some more examples, I think it's enough :-)
  37.  
  38. Here is the solution for these problems, an easy-to-use, fast and
  39. powerful CLI-type proggie that allows you to upload files to users
  40. and file-areas with full support of DLG's very own data-files and
  41. structures...
  42.  
  43.  
  44. DLGUpload (v 0.60), what does it ??
  45. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  46. - allows to specify a Description (upto 255 chars)
  47. - allows to specify a Textfile to take the Description from
  48. - allows to specify an Uploader
  49. - allows to make the file [FREE]
  50. - allows to set a default [Number_of_Downloads] (useful for TICK-Files)    **
  51. - no need of "C:Copy" or other stuff and even SHORTER
  52.   than similar proggies... (currently less than 10k, 100% machine-code)
  53. - seems to be quite safe and requires a minimum of 40 k of memory
  54. - uses alternate storage paths from File:area.bbs
  55. - uses file:[area]/file.dat
  56. - uses User:First_Last/event.log on private Uploads
  57.  
  58. (When information on DLG.library will be available, DLGUpload might
  59.  also use system-messages or alter the upload-counters in the
  60.  Uploader's user.data-file :-)
  61. (^^^^^^^^^^^^^^^^^^^^^^^^^ this one has been added now, but we are not
  62.  sure how save it will work... you should NOT use it until a "DLG.library-
  63.  Version" of DLGUpload will be available...)
  64.  
  65.  
  66. How does it work ??
  67. ~~~~~~~~~~~~~~~~~~~
  68. When called, it will copy the specified file to the destination
  69. directory, look for a pointers.file, write a .fd-file, update the
  70. pointers.file and the file.dat. If no pointers.file or file.dat
  71. is found, one will be generated (only thing it does not is create
  72. File:Area.bbs if not existant :-)
  73.  
  74. ** IMPORTANT CHANGE **
  75.  
  76. from version 0.58, DLGUpload has changed to be "DLG-compatible" in the
  77. way it is called. The syntax is now more similar to the original DLG-Modules,
  78. so if you have used older versions of DLGUpload, you _MUST_ change all scripts
  79. and stuff the use it !!!!
  80.  
  81. The command-line for DLGUpload NOW is:
  82.  
  83. DLGUpload [option <parameter>](s) <flags>
  84.  
  85. with the follwing options:
  86.  
  87.    -f <Sourcename>    is the path of the file which is to be uploaded.
  88.                       (this one is the only REQUIRED parameter)
  89.  
  90.    -a <Area>          is the place where the file should be uploaded to.
  91.                       there is no more need to specify a full path here,
  92.                       You only have to insert the NUMBER of the file-area
  93.                       or the (underscored) NAME of a User. (You still CAN
  94.                       specify a Path, but if it's NOT a recognizable
  95.                       DLG-File/User-Directory, DLGUpload will NOT work!!
  96.                       If it's an alternate path or similar, DLGUpload will
  97.                       know where to put the File and where to put the other
  98.                       stuff.. so you needn't care of that !! :-)
  99.  
  100.    -d <Description>   is a short description that will be placed in the
  101.                       header-file (max. 255 chars).
  102.                       If it's more than one word, it should be between
  103.                       quotes ("").
  104.                       If you use the DESCFILE-flag, then this parameter
  105.                       specifies the Path/Filename of the text that will be
  106.                       used as description.
  107.  
  108.    -u <Uploader>      the name that will be shown as Uploader in the
  109.                       header-file.
  110.                       If you use the CREDITS-flag, the Upload-credits of
  111.                       the specified user will be modified to reflect this
  112.                       upload !! (Use at wour own risk !!)
  113.  
  114.    -n <TimesDL>       this should be a number and will be set as the
  115.                       NumberofDownloads in the Header. (Useful if you
  116.                       have many File-Echos that you forward to other
  117.                       systems. E.g if you have X Downlinks that get the
  118.                       file from you, set <TimesDL> to X).
  119.  
  120. and here are the flags:
  121.  
  122.    FREE               must I really tell you ???
  123.  
  124.    DEL                this tells DLGUpload to delete the original File
  125.                       (perform a MOVE rather than a COPY) after moving it
  126.                       to the File-Area.
  127.                       Useful for File-Echos to remove the Files from the
  128.                       Inbound-Directory when uploading them to the BBS
  129.  
  130.    DESCFILE           this tells DLGUpload that it shall read the File
  131.                       specified with the -d option and use its contents
  132.                       as the File-Description in the File-Header.
  133.                       BE CAREFUL: there is NO check wheter the file is
  134.                       really an ASCII-Text !! Also there is no limit in
  135.                       length (you could, for example, tell DLGUpload to
  136.                       use your 1-Meg-ASCII-Nodelist as description, and
  137.                       it WOULD DO SO !!!)
  138.  
  139.    CREDITS            this tells DLGUpload that the length of the File
  140.                       shall be added to the upload-credits of the User
  141.                       specified with the -u option. This function has not
  142.                       been tested very much, so I recommend you NOT using
  143.                       it until there is an OK from TPT or a newer version
  144.                       of DLGUpload that uses DLG.library to access the user's
  145.                       datafile.
  146.  
  147.  
  148. If you don't use the -a option, the File should be uploaded to the current
  149. directory (if it is a DLG-File/User-Directory, if not, there will be some weird
  150. error-message like "Destination Directory doesn't exist!!" :-)
  151.  
  152. The minimum is:
  153.  
  154. DLGUpload -f <filename>
  155.  
  156. all other parameters will get defaults then...
  157.  
  158.  
  159. Examples:
  160. ~~~~~~~~~
  161.  
  162. DLGUpload -f s:user-startup -a marcus_kuba -d "Just a test" -u "Michael Dreher"
  163.  
  164. - will upload the file s:user-startup to Marcus Kuba's private
  165. file-area with a description of "Just a test" and Michael Dreher as
  166. uploader.
  167.  
  168. DLGUpload -f RAM:FF560.lzh -a 31 -d ram:Contents560 DESCFILE DEL FREE
  169.  
  170. - will upload the File FF560.lzh to File-Area 31 with the FREE-Flag
  171. set and uses the file "RAM:Contents560" as description. The original File
  172. will be deleted after the upload.
  173.  
  174. cd File:89
  175. DLGUpload -f S:PC-Startup
  176. DLGUpload -f Testfile
  177.  
  178. - will upload the files 'S:PC-Startup' and 'Testfile' in file area 89
  179.   and uses default uploader and default description
  180.  
  181.  
  182. See also the supplied scripts and configs for information on how to setup
  183. DLGUpload together with FTick, Peer Hasselmeyer's flexible Tick-proggy !!
  184.  
  185.  
  186. How must I install it ??
  187. ~~~~~~~~~~~~~~~~~~~~~~~~
  188. Oh, this is the simplest.., just copy DlgUpload anywhere in your path,
  189. we have it in C: right now. For easier use you can rename it to "Upload", this
  190. is what we have done :-)
  191. Be careful to change all your scripts that use older versions of DLGUpload so
  192. that they reflect the changes in the syntax !!!
  193.  
  194.  
  195. CopyRight:
  196. ~~~~~~~~~~
  197. DLGUpload is Freeware, which means that you can spread it to anyone
  198. you like, as long as all files are intact and the original archive
  199. is NOT altered (this means also that you may NOT add any files
  200. or change the ZZZIBASE.foo textfile included in this archive !!).
  201. If you like and use DlgUpload, it would by nice, if you send us
  202. YOUR Freeware/Shareware proggies, even a message would be nice...
  203.  
  204.  
  205. author:
  206.  
  207.             Michael Dreher
  208.             Wielandstr. 12
  209.             7250 Leonberg
  210.             West Germany
  211.  
  212. Fido Netmail:  2:247/706.1  IBase Point 1
  213.                             (Intuition-Base ++49-7152-45768)
  214. UUCP email:    Michael_Dreher@ibase.stgt.sub.org
  215.  
  216. or write to:
  217.  
  218. Marcus Kuba, SysOp of 2:247/706 / ibase.stgt.sub.org
  219. (Intuition-Base: DLGTopX, DLGUpload and CONTRIS!-Support-BBS :-)
  220.  
  221. Special thanks:
  222. ~~~~~~~~~~~~~~~
  223. Marcus Kuba      : - He had the ideas for the additional features
  224.                    - He wrote this documentation.
  225.  
  226. Tom Conroy (TPT) : - for DLG Pro and testing DLGUpload
  227.  
  228. Patrick Young    : - for A68k 2.71 (which was used to make DLGUpload)
  229.  
  230. Maurizio Fabiani : - for your ideas and Beta-Testing
  231.  
  232. Heiko Richter    : - for the DLG-Support-Echos, ADS/SAN/ANSINET and Beta-Testing
  233.  
  234. Peer Hasselmeyer : - for FTick 0.84, the proggy that made it possible to get
  235.                      rid of the old buggy CSTick :-)
  236.  
  237.  
  238. Disclaimer:
  239. ~~~~~~~~~~~
  240.  
  241. We are in no way responsible for anything this program does; You are using it
  242. entirely at your own risk ! (This means that if DLGUpload formats your
  243. harddisk, it's your personal problem :-), but you can believe me: it
  244. has been tested long enough to be safe...)
  245.